﻿/*
 * Cratos Tools - General
 * Cratos Enum declarations
 * 
 * Copyright (c) 2011-2012 Draco
 * 
 * This file is part of Cratos.
 * 
 * Cratos is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * Cratos is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Cratos.  If not, see <http://www.gnu.org/licenses/>.
 * 
 *       .==.        .==.
 *      //'^\\      //^'\\
 *     // ^ ^\(\__/)/^ ^^\\
 *    //^ ^^ ^/6  6\ ^^ ^ \\
 *   //^ ^^ ^/( .. )\^ ^ ^ \\
 *  // ^^ ^/\| V""V|/\^ ^ ^ \\
 * //^^/\/ /  '~~'  \ \/\^ ^ \\
 *  ------------------------------------
 *  HERE BE DRAGONS
 *  
 *  Johan Dercksen - johan@draco.co.za
 */
using System;

namespace Cratos.Tools.General
{
	/// <summary>
	/// Cratos Log Severity Enum declaration
	/// </summary>
	public enum CratosLogSeverity
	{
		/// <summary>
		/// Informational Message
		/// </summary>
		Informational,

		/// <summary>
		/// Warning Message
		/// </summary>
		Warning,

		/// <summary>
		/// Exception Message
		/// </summary>
		Exception,

		/// <summary>
		/// Validation Error
		/// </summary>
		ValidationError
	}

	/// <summary>
	/// Cratos Data Object Action Enum declaration
	/// </summary>
	public enum DOCratosAction
	{
		/// <summary>
		/// No Action
		/// </summary>
		None,

		/// <summary>
		/// Create
		/// </summary>
		Create,

		/// <summary>
		/// Retrieve
		/// </summary>
		Retrieve,

		/// <summary>
		/// Update
		/// </summary>
		Update,

		/// <summary>
		/// Delete
		/// </summary>
		Delete,

		/// <summary>
		/// Custom Action
		/// </summary>
		Custom
	}

	/// <summary>
	/// Cratos Action Result
	/// </summary>
	public enum DOCratosActionResult
	{
		/// <summary>
		/// No result
		/// </summary>
		None,

		/// <summary>
		/// Action Successful
		/// </summary>
		Success,

		/// <summary>
		/// No Records
		/// </summary>
		NoRecords,

		/// <summary>
		/// Error occurred
		/// </summary>
		Error,

		/// <summary>
		/// Timeout occurred
		/// </summary>
		Timeout
	}

	/// <summary>
	/// Cratos Data Object Action Type
	/// </summary>
	public enum DOCratosActionType
	{
		/// <summary>
		/// Stored Procedure
		/// </summary>
		StoredProcedure,

		/// <summary>
		/// SQL String
		/// </summary>
		SqlString,

		/// <summary>
		/// Custom ADO Driver
		/// </summary>
		CustomADODriver
	}

	/// <summary>
	/// Database type
	/// </summary>
	/// <remarks>
	/// This enum is used to specify what type of database access is required.
	/// The valid options are SQLServer and ODBC
	/// </remarks>
	public enum CratosDatabaseType
	{
		/// <summary>
		/// SQL Server Database
		/// </summary>
		/// <remarks>
		/// The database is a SQL server
		/// </remarks>
		SqlServer = 0,

		/// <summary>
		/// ODBC Datasource
		/// </summary>
		/// <remarks>
		/// The database is an ODBC datasource
		/// </remarks>
		Odbc,

		/// <summary>
		/// Custom ADO Driver
		/// </summary>
		CustomADODriver,

		/// <summary>
		/// SQL Server CE
		/// </summary>
		SqlCeServer
	};

	/// <summary>
	/// Cratos Database Result enum declaration
	/// </summary>
	public enum CratosDatabaseResult
	{
		/// <summary>
		/// Success
		/// </summary>
		Success,

		/// <summary>
		/// Timeout occurred
		/// </summary>
		Timeout,

		/// <summary>
		/// Exception ocurred
		/// </summary>
		Exception
	}

	/// <summary>
	/// Cratos Collection Action enum declaration
	/// </summary>
	public enum DOCratosCollectionAction
	{
		/// <summary>
		/// No Action
		/// </summary>
		None,

		/// <summary>
		/// Retrieve Collection data
		/// </summary>
		Retrieve,

		/// <summary>
		/// Various Actions
		/// </summary>
		Various,

		/// <summary>
		/// Custom Action
		/// </summary>
		Custom
	}

	/// <summary>
	/// Cratos Data Object Dependancy enum declaration
	/// </summary>
	public enum DOCratosDependancy
	{
		/// <summary>
		/// No dependency
		/// </summary>
		None,

		/// <summary>
		/// Dependent on Parent object
		/// </summary>
		Parent,

		/// <summary>
		/// Dependent on Child object
		/// </summary>
		Child
	}

	/// <summary>
	/// Cratos Action Property Direction
	/// </summary>
	public enum DOCratosActionPropertyDirection
	{
		/// <summary>
		/// Direction - NONE
		/// </summary>
		None,

		/// <summary>
		/// Direction - IN
		/// </summary>
		In,

		/// <summary>
		/// Direction - OUT
		/// </summary>
		Out,

		/// <summary>
		/// Direction - IN and OUT
		/// </summary>
		InOut
	}
}
